package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.PolicyPermissionsAddDTO;
import org.jsola.hr.dto.PolicyPermissionsUpdateDTO;
import org.jsola.hr.query.PolicyPermissionsQuery;
import org.jsola.hr.vo.PolicyPermissionsListVO;
import org.jsola.hr.vo.PolicyPermissionsVO;

import java.util.List;

/**
 * 政策速递权限
 *
 * @author zhr
 */
@Api(tags = "hr-政策速递权限")
public interface IPolicyPermissionsControllerAPI {

    /**
     * 新增政策速递权限
     * @param policyPermissionsAddDTO 政策速递权限新增实体
     * @return 政策速递权限展示对象
     */
    @ApiOperation(value = "新增政策速递权限")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsAddDTO", dataType = "PolicyPermissionsAddDTO", value = "新增政策速递权限", paramType = "body")
    })
    Result<PolicyPermissionsVO> save(PolicyPermissionsAddDTO policyPermissionsAddDTO);


    /**
     * 修改政策速递权限
     * @param policyPermissionsUpdateDTO 政策速递权限
     * @return 更新数量
     */
    @ApiOperation(value = "修改政策速递权限")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsUpdateDTO", dataType = "PolicyPermissionsUpdateDTO", value = "修改政策速递权限", paramType = "body")
    })
    Result<Integer> update(PolicyPermissionsUpdateDTO policyPermissionsUpdateDTO);




    /**
     * 删除单个政策速递权限，彻底删除
     * @param policyPermissionsId 政策速递权限id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个政策速递权限，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsId", dataType = "String", value = "政策速递权限id", paramType = "path")
    })
    Result<Integer> delete(String policyPermissionsId);


    /**
     * 批量删除政策速递权限，彻底删除
     * @param policyPermissionsIds 政策速递权限id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除政策速递权限，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsIds", dataType = "String[]", value = "政策速递权限id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] policyPermissionsIds);


    /**
     * 根据政策速递权限id查询政策速递权限详情
     * @param policyPermissionsId 政策速递权限id
     * @return 政策速递权限详情
     */
    @ApiOperation(value="根据政策速递权限id查询政策速递权限详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsId", dataType = "String", value = "政策速递权限id", paramType = "path")
    })
    Result<PolicyPermissionsVO> findById(String policyPermissionsId);


    /**
     * 查询政策速递权限
     * @param policyPermissionsQuery 政策速递权限查询参数
     * @return page
     */
    @ApiOperation(value="查询政策速递权限")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsQuery", dataType = "PolicyPermissionsQuery", value = "政策速递权限查询参数", paramType = "query")
    })
    Result<List<PolicyPermissionsListVO>> listAll(PolicyPermissionsQuery policyPermissionsQuery);


     /**
     * 分页查询政策速递权限
     * @param policyPermissionsQuery 政策速递权限查询参数
     * @return page
     */
    @ApiOperation(value="分页查询政策速递权限")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyPermissionsQuery", dataType = "PolicyPermissionsQuery", value = "政策速递权限查询参数", paramType = "query")
    })
    Result<Page<PolicyPermissionsListVO>> page(PolicyPermissionsQuery policyPermissionsQuery);


}

